WorldWind Kotlin/earth.worldwind/[web]WorldWindow

WorldWindow

open class WorldWindow(val canvas: HTMLCanvasElement, renderResourceCache: RenderResourceCache = RenderResourceCache(), prepareEvent: PrepareEventHandler = createDefaultPrepareEventHandler(canvas)) : WorldWind.EventListener

Represents a WorldWind window for an HTML canvas.

Constructors

WorldWindow

constructor(canvas: HTMLCanvasElement, renderResourceCache: RenderResourceCache = RenderResourceCache(), prepareEvent: PrepareEventHandler = createDefaultPrepareEventHandler(canvas))

Types

Companion

object Companion

RedrawStage

enum RedrawStage : Enum<WorldWindow.RedrawStage>

Properties

canvas

val canvas: HTMLCanvasElement

The HTML canvas associated with this WorldWindow.

controller

var controller: WorldWindowController

The controller used to manipulate the globe.

engine

open val engine: WorldWind

Main WorldWind engine, containing globe, terrain, renderable layers, camera, viewport and frame rendering logic.

keyboardControls

open val keyboardControls: KeyboardControls

The controller used to manipulate the globe with the keyboard.

redrawCallbacks

val redrawCallbacks: MutableSet<(WorldWindow, WorldWindow.RedrawStage) -> Unit>

The list of callbacks to call immediately before and immediately after performing a redrawn. The callbacks have two arguments: this WorldWindow and the redraw stage, e.g., redrawCallback(worldWindow, stage);. The stage will be either WorldWind.BEFORE_REDRAW or WorldWind.AFTER_REDRAW indicating whether the callback has been called either immediately before or immediately after a redrawn, respectively. Applications may add functions to this array or remove them.

selectDragDetector

open val selectDragDetector: SelectDragDetector

Renderable selection and drag gestures detector. Assign SelectDragDetector.callback to handle events.

Functions

addEventListener

fun addEventListener(type: String, listener: (Event) -> Unit)

Registers an event listener for the specified event type on this WorldWindow's canvas. This function delegates the processing of events to the WorldWindow's canvas. For details on this function and its arguments, see the W3C org.w3c.dom.events.EventTarget documentation.

canvasCoordinates

fun canvasCoordinates(x: Number, y: Number): Vec2

Converts window coordinates to coordinates relative to this WorldWindow's canvas.

pick

fun pick(pickPoint: Vec2): PickedObjectList

Requests the WorldWind objects displayed at a specified screen-coordinate point.

pickShapesInRegion

fun pickShapesInRegion(x: Double, y: Double, width: Double = 0.0, height: Double = 0.0, pickCenter: Boolean = true): PickedObjectList

Requests the WorldWind objects displayed within a specified screen-coordinate region. This returns all objects that intersect the specified region, regardless of whether an object is actually visible, and marks objects that are visible as on top.

removeEventListener

fun removeEventListener(type: String, listener: (Event) -> Unit)

Removes an event listener for the specified event type from this WorldWindow's canvas. The listener must be the same object passed to addEventListener. Calling removeEventListener with arguments that do not identify a currently registered listener has no effect.

requestRedraw

open override fun requestRedraw()

Causes this WorldWindow to redraw itself at the next available opportunity. The redrawn occurs on the main thread at a time of the browser's discretion. Applications should call redraw after changing the World Window's state, but should not expect that change to be reflected on screen immediately after this function returns. This is the preferred method for requesting a redrawn of the WorldWindow.

unmarkResourceAbsent

open override fun unmarkResourceAbsent(resourceId: Int)

Removes resource ID from the missed resource list